.. _cmlPmHomeGetSpeedPattern:

cmlPmHomeGetSpeedPattern
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

  VT_I4 cmlPmHomeGetSpeedPattern([in] VT_I4 BoardID, [in] VT_I4 NodeId, [in] VT_I4 Channel, 
  [out] VT_PI4 SpeedMode, [out] VT_PR8 Vel, [out] VT_PR8 Accel, 
  [out] VT_PR8 Decel, [out] VT_PR8 RevVel )         

DESCRIPTION
`````````````  

- cmlPmHomeSetSpeedPattern()/cmlPmHomeGetSpeedPattern() 함수는 설정된 축의 원점복귀 속도 모드와 
  가속/감속도 및 작업속도, 역방향속도를 설정 및 설정 상태를 반환합니다.  

\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cml 가 붙지 않습니다.


PARAMETER
`````````````

▶ BoardID : 사용자가 설정한 디바이스(보드) ID. 
 
▶ NodeId : 노드 번호. 노드 번호는 3부터 시작합니다. 
 
▶ Channel : 축 번호. 통합 축으로 관리되는 축 번호를 의미하며, 상수 값으로 0 (Zero Based) 이상, 최대 
통합 축 개수 - 1 이하의 값을 축 번호로 설정할 수 있습니다. 
 
▶ SpeedMode : cmlPmHomeSetSpeedPattern() 함수의 인자이며, 원점복귀 시의 S-Curve 형 또는 선형 
가감속, 가감속이 없는 모드등, 원점복귀 속도모드를 설정 혹은 반환합니다.

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
    0 (cmlMODE_C), CONSTANT 속도모드 => 가감속을 수행하지 않습니다.
    1 (cmlMODE_T), TRAPEZOIDAL 속도모드 => 사다리꼴 가감속을 수행합니다. 
    2 (cmlMODE_S), S-CURVE 속도모드 => S-CURVE 가감속을 수행합니다. 
    -1 (ccmlSMODE_KEEP), 이전 속도 모드를 유지합니다. 

▶ SpeedMode : cmlPmHomeGetSpeedPattern() 함수의 인자이며, 원점복귀 시의 S-Curve 형 또는 선형 
가감속, 가감속이 없는 모드등, 원점복귀 속도모드를 설정 혹은 반환합니다.

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
    0 (cmlMODE_C), CONSTANT 속도모드 => 가감속을 수행하지 않습니다.
    1 (cmlMODE_T), TRAPEZOIDAL 속도모드 => 사다리꼴 가감속을 수행합니다. 
    2 (cmlMODE_S), S-CURVE 속도모드 => S-CURVE 가감속을 수행합니다. 


▶ Vel : 원점 복귀 작업 속도를 설정 혹은 반환합니다. 기호로는 Vwork 로 표기합니다. 

▶ Accel : 원점 복귀 가속도를 설정 혹은 반환합니다. 

▶ Decel : 원점 복귀 감속도를 설정 혹은 반환합니다. 

▶ RevVel : Reverse Speed 를 설정 혹은 반환합니다. 원점 복귀 모드에 따라 Reverse Speed 를 필요로 하는 
모드가 있습니다. 앞의 원점 복귀 모드 설명에서 Reverse Speed 는 Vr 로 표기되었습니다. 


RETURN VALUE
`````````````

.. csv-table::
  :widths: 10 90
  :header-rows: 1
  :stub-columns: 0

  Value, Meaning
  음수, 수행 실패
  ERR_NONE, 수행 성공

EXAMPLE
`````````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

  C/C++ 
  #include “ComiMLink2_SDK.h” 
  #include “ComiMLink2_SDK_Def.h” 
  long nHmSpdMode = 0; 
  double fVel = 0.0f, fAcc = 0.0f, fDec = 0.0f, fRevVel = 0.0f; 
  long BoardID = 0; 
  //0번 축의 원점 복귀 속도 옵션을 설정합니다. 
  cmlPmHomeSetSpeedPattern (BoardID, 0, ccmlX1, cmlMODE_S, 5000, 1000, 1000, 1000 ); 
  //0번 축에 설정된 홈 복귀 옵션을 반환합니다. 
  cmlPmHomeGetSpeedPattern (BoardID, 0, ccmlX1, &nHmSpdMode, &fVel, &fAcc, &fDec, &fRevVel );